feat: add warning for binary string in "application/json" or parameter #139

barrett-schonefeld · 2020-02-13T18:56:35Z

Changes:

added a findOctetSequencePaths function to handle the logic of finding schema type: string, format: binary for cases of nested arrays, objects, nested arrays of type object, objects with properties that are nested arrays, and objects with properties that are objects, and the simple case where a schema uses type: string, format: binary directly. This function takes a resolved schema and returns a list of paths to octet sequences (empty list if none found). The function accepts the path both as an array and a string and returns the path in the same format received.
added logic to handle application/json request bodies that use schema type: string, format: binary
added logic to handle application/json response bodies of type: string, format: binary
added logic to handle parameters of type: string, format: binary
removed 'binary' as a valid format for type: string parameters. parameters of type: string, format: binary will result in "type+format not well-defined" error
added "json_or_param_binary_string" as to .defaultsForValidator as a warning in the shared.schemas section
added "json_or_param_binary_string" configuration option to the README.md rules and defaults sections in the schemas section
changed findOctetSequencePaths to accept the path both as a string and an array.

Refactoring in responses.js:

moved the check for 204-response with content to be part of the other success code checks
added a function to get all response codes, all status codes, and all success codes

Tests:

added tests to ensure warnings are issued for request bodies, response bodies, and parameters with schema, type: string, format: binary
added complex tests to exercise combinations of nested arrays and objects that contain schema type: string, format: binary (complex tests done on response bodies)

codecov · 2020-02-13T19:12:36Z

Codecov Report

Merging #139 into master will increase coverage by 0.22%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #139      +/-   ##
==========================================
+ Coverage   92.99%   93.22%   +0.22%     
==========================================
  Files          59       60       +1     
  Lines        2156     2229      +73     
==========================================
+ Hits         2005     2078      +73     
  Misses        151      151

Impacted Files	Coverage Δ
...dation/2and3/semantic-validators/parameters-ibm.js	`93.02% <ø> (ø)`	⬆️
src/.defaultsForValidator.js	`100% <ø> (ø)`	⬆️
.../validation/oas3/semantic-validators/parameters.js	`100% <100%> (ø)`	⬆️
.../validation/oas3/semantic-validators/operations.js	`97.91% <100%> (+0.61%)`	⬆️
...s/validation/oas3/semantic-validators/responses.js	`100% <100%> (ø)`	⬆️
src/plugins/utils/findOctetSequencePaths.js	`100% <100%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ab2bc90...81eacff. Read the comment docs.

mkistler

This is heading in the right direction but I left some comments with suggested improvements or questions.

src/plugins/utils/hasOctetSequence.js

src/plugins/validation/oas3/semantic-validators/responses.js

test/plugins/validation/oas3/operations.js

test/plugins/validation/oas3/parameters.js

dpopp07

There are a few minor changes to make and then potentially larger changes in how we handle the configuration situation. I also would like to see one positive test that proves the correct usage of a binary property will not create a warning.

README.md

src/plugins/validation/oas3/semantic-validators/operations.js

src/plugins/validation/oas3/semantic-validators/parameters.js

test/plugins/validation/oas3/operations.js

dpopp07

Looking pretty good. Probably the last thing to do is discuss the config stuff. I'll think about it and get back to you

test/plugins/validation/oas3/parameters.js

src/.defaultsForValidator.js

dpopp07

One little thing to address, but looks good otherwise! I'm approving but I'll wait to merge in case @mkistler wants to take one more look at it

test/plugins/validation/oas3/parameters.js

…r parameter - added a findOctetSequencePaths function to handle the logic of finding schema type: string, format: binary for cases of nested arrays, objects, nested arrays of type object, objects with properties that are nested arrays, and objects with properties that are objects, and the simple case where a schema uses type: string, format: binary directly. This function takes a schema object from a resolvedSpec and returns a list of paths to octet sequences (empty list if none found). The function accepts the path both as an array and a string and returns the path in the same format received. - added logic to handle application/json request bodies that use schema type: string, format: binary - added logic to handle application/json response bodies of type: string, format: binary - added logic to handle parameters of type: string, format: binary - removed 'binary' as a valid format for type: string parameters. parameters of type: string, format: binary will result in "type+format not well-defined" error - added tests to ensure warnings are issued for request bodies, response bodies, and parameters with schema, type: string, format: binary - added complex tests to exercise combinations of nested arrays and objects that contain schema type: string, format: binary (complex tests done on response bodies) - added "json_or_param_binary_string" as to .defaultsForValidator as a warning in the oas3.schemas section - added "json_or_param_binary_string" configuration option to the README.md rules and defaults sections in the oas3 schemas section - changed findOctetSequencePaths to accept the path both as a string and an array.

dpopp07

Looks good! I'll see if @mkistler wants to take one more look and then merge this morning

Requested changes have been addressed

# [0.21.0](v0.20.0...v0.21.0) (2020-02-18) ### Features * add validator warning for binary string in "application/json" or parameter ([#139](#139)) ([9497333](9497333))

dpopp07 · 2020-02-18T16:12:35Z

🎉 This PR is included in version 0.21.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

barrett-schonefeld requested review from mkistler and dpopp07 February 13, 2020 18:56

barrett-schonefeld force-pushed the issue-1416 branch from aa5da53 to 99b7580 Compare February 13, 2020 18:58

barrett-schonefeld force-pushed the issue-1416 branch from 99b7580 to 6db9bae Compare February 13, 2020 19:24

barrett-schonefeld added the ready-for-review label Feb 13, 2020

barrett-schonefeld changed the title ~~feat: add validator warning for binary string in "application/json" or parameter~~ feat: add warning for binary string in "application/json" or parameter Feb 13, 2020

barrett-schonefeld changed the title ~~feat: add warning for binary string in "application/json" or parameter~~ wip: add warning for binary string in "application/json" or parameter Feb 13, 2020

barrett-schonefeld removed the ready-for-review label Feb 13, 2020

barrett-schonefeld force-pushed the issue-1416 branch from 6db9bae to a75e405 Compare February 14, 2020 13:52

barrett-schonefeld added the ready-for-review label Feb 14, 2020

barrett-schonefeld changed the title ~~wip: add warning for binary string in "application/json" or parameter~~ feat: add warning for binary string in "application/json" or parameter Feb 14, 2020

barrett-schonefeld force-pushed the issue-1416 branch from a75e405 to c3841cb Compare February 14, 2020 17:33

barrett-schonefeld assigned dpopp07 Feb 14, 2020

barrett-schonefeld force-pushed the issue-1416 branch from c3841cb to 37d6184 Compare February 14, 2020 20:15

mkistler previously requested changes Feb 17, 2020

View reviewed changes

barrett-schonefeld force-pushed the issue-1416 branch from 37d6184 to f79022b Compare February 17, 2020 15:26

barrett-schonefeld requested a review from mkistler February 17, 2020 15:26

barrett-schonefeld force-pushed the issue-1416 branch from f79022b to 2fd0c5d Compare February 17, 2020 16:47

dpopp07 requested changes Feb 17, 2020

View reviewed changes

barrett-schonefeld force-pushed the issue-1416 branch 2 times, most recently from 1802907 to 5823533 Compare February 17, 2020 19:24

barrett-schonefeld requested a review from dpopp07 February 17, 2020 19:25

dpopp07 requested changes Feb 17, 2020

View reviewed changes

test/plugins/validation/oas3/parameters.js Outdated Show resolved Hide resolved

src/.defaultsForValidator.js Outdated Show resolved Hide resolved

barrett-schonefeld force-pushed the issue-1416 branch 3 times, most recently from 0d6fe7f to b72f2cb Compare February 17, 2020 20:31

barrett-schonefeld requested a review from dpopp07 February 17, 2020 20:34

dpopp07 approved these changes Feb 17, 2020

View reviewed changes

test/plugins/validation/oas3/parameters.js Outdated Show resolved Hide resolved

barrett-schonefeld force-pushed the issue-1416 branch from b72f2cb to b36b036 Compare February 17, 2020 20:57

barrett-schonefeld changed the title ~~feat: add warning for binary string in "application/json" or parameter~~ wip: add warning for binary string in "application/json" or parameter Feb 17, 2020

barrett-schonefeld force-pushed the issue-1416 branch from b36b036 to 90aec33 Compare February 18, 2020 13:42

barrett-schonefeld changed the title ~~wip: add warning for binary string in "application/json" or parameter~~ feat: add warning for binary string in "application/json" or parameter Feb 18, 2020

barrett-schonefeld assigned mkistler Feb 18, 2020

barrett-schonefeld requested a review from dpopp07 February 18, 2020 13:45

barrett-schonefeld force-pushed the issue-1416 branch from 90aec33 to 81eacff Compare February 18, 2020 14:20

dpopp07 approved these changes Feb 18, 2020

View reviewed changes

dpopp07 merged commit 9497333 into master Feb 18, 2020

dpopp07 deleted the issue-1416 branch February 18, 2020 15:15

barrett-schonefeld mentioned this pull request Feb 18, 2020

refactor: introduces MessageCarrier to simplify adding warnings and errors #141

Merged

dpopp07 pushed a commit that referenced this pull request Feb 18, 2020

chore(release): 0.21.0 [skip ci]

a29043a

# [0.21.0](v0.20.0...v0.21.0) (2020-02-18) ### Features * add validator warning for binary string in "application/json" or parameter ([#139](#139)) ([9497333](9497333))

dpopp07 added the released label Feb 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add warning for binary string in "application/json" or parameter #139

feat: add warning for binary string in "application/json" or parameter #139

barrett-schonefeld commented Feb 13, 2020 •

edited

Loading

codecov bot commented Feb 13, 2020 •

edited

Loading

mkistler left a comment

dpopp07 left a comment

dpopp07 left a comment

dpopp07 left a comment

dpopp07 left a comment

dpopp07 commented Feb 18, 2020

feat: add warning for binary string in "application/json" or parameter #139

feat: add warning for binary string in "application/json" or parameter #139

Conversation

barrett-schonefeld commented Feb 13, 2020 • edited Loading

codecov bot commented Feb 13, 2020 • edited Loading

Codecov Report

mkistler left a comment

Choose a reason for hiding this comment

dpopp07 left a comment

Choose a reason for hiding this comment

dpopp07 left a comment

Choose a reason for hiding this comment

dpopp07 left a comment

Choose a reason for hiding this comment

dpopp07 left a comment

Choose a reason for hiding this comment

dpopp07 commented Feb 18, 2020

barrett-schonefeld commented Feb 13, 2020 •

edited

Loading

codecov bot commented Feb 13, 2020 •

edited

Loading